Schoology Dev Docs

Appearance

Blog Post ​

Blog posts can be created for any realm.

NOTE

Blog posts exist in districts, schools, users, groups, and sections.

Fields ​

FieldNameDescriptionType
title*TitleThe post title.string
bodyPost bodyThe post body. Rendered as HTML — line breaks need a <br />.string

* = Required

GET {realm}/posts ​

View a list of posts (paged)

Return A list of post objects

json
{
  "post": [
    {
      "id": "5615055",
      "title": "PHP meetup",
      "body": "Let's meet and chat about PHP",
      "created": 1386886391,
      "links": {
        "self": "http:\/\/...\/posts\/5615055"
      }
    },
    {
      "id": "5615045",
      "title": "REST API meetup",
      "body": "Let's meet and chat about REST API",
      "created": 1386886221,
      "links": {
        "self": "http:\/\/...\/posts\/5615045"
      }
    }
  ]
}
xml
<?xml version="1.0" encoding="utf-8" ?>
<result>
  <post>
    <id>5615055</id>
    <title>PHP meetup</title>
    <body>Let's meet and chat about PHP</body>
    <created>1386886391</created>
    <links>
      <self>http://.../5615055</self>
    </links>
  </post>
  <post>
    <id>5615045</id>
    <title>REST API meetup</title>
    <body>Let's meet and chat about REST API</body>
    <created>1386886221</created>
    <links>
      <self>http://.../5615045</self>
    </links>
  </post>
</result>

GET {realm}/posts/{id} ​

View a specified blog post

Return A post

json
{
  "id": "5615045",
  "title": "REST API meetup",
  "body": "Let's meet and chat about REST API",
  "created": 1386886221
}
xml
<?xml version="1.0" encoding="utf-8" ?>
<result>
  <id>5615045</id>
  <title>REST API meetup</title>
  <body>Let's meet and chat about REST API</body>
  <created>1386886221</created>
</result>

POST {realm}/posts ​

Create a blog post

Content A post

json
{
  "title": "My first blog",
  "body": "<strong>my blog content<\/strong>"
}
xml
<body>
  <title>My first blog</title>
  <body>&lt;strong&gt;my blog content&lt;/strong&gt;</body>
</body>

Return A post

json
{
  "id": "5615045",
  "title": "REST API meetup",
  "body": "Let's meet and chat about REST API",
  "created": 1386886221,
  "links": {
    "self": "http:\/\/...\/posts\/5615045"
  }
}
xml
<?xml version="1.0" encoding="utf-8" ?>
<result>
  <id>5615045</id>
  <title>REST API meetup</title>
  <body>Let's meet and chat about REST API</body>
  <created>1386886221</created>
  <links>
    <self>http://.../5615045</self>
  </links>
</result>

PUT {realm}/posts/{id} ​

Modify a blog post

Content An object containing blog post fields

json
{
  "title": "My new blog title"
}
xml
<body>
  <title>My new blog title</title>
</body>

DELETE {realm}/posts/{id} ​

Delete a blog post (cannot be undone)